Note: Before using SCIM2, you must first configure a ResourceType in the Settings > Server Front-End > SCIM configuration page.
USAGE:
List all entries for a resource type:
GET /scim2/v2/[ResourceType Endpoint]
Get a specific entry for a resource type:
GET /scim2/v2/[ResourceType Endpoint]/[Entry DN]
Create a new entry for a resource type:
POST /scim2/v2/[ResourceType Endpoint]
Example
-
POST
https://dev-rest-fo.dev00.radiantlogic.io:${serverPort}/scim2/v2/Users
POST Body:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"displayName" : "James_Bond",
"userName": "James_Bond",
"title": "Secret Agent",
"nickName": "007",
"addresses": [
{
"locality": "London",
"type": "home"
}
],
"phoneNumbers": [
{
"value": "+1 000 000 0007",
"type": "mobile"
},
{
"value": "+1 007 000 0007",
"type": "home"
}
],
"name": {
"givenname": "James",
"familyName": "Bond",
"formatted":"James Bond"
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "007"
}
}
Update (replace entire state) an existing entry for a resource type:
PUT /scim2/v2/[ResourceType Endpoint]/[Entry DN]
Example
-
PUT
https://dev-rest-fo.dev00.radiantlogic.io:${serverPort}/scim2/v2/Users/uid=James_Bond,o=companydirectory
PUT Body:
{
"id": "uid=James_Bond,o=companydirectory",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"displayName": "James_Bond_007",
"userName": "James_Bond",
"title": "Spy",
"phoneNumbers": [
{
"value": "+1 123 456 0007",
"type": "home"
},
{
"value": "+1 000 000 0007",
"type": "mobile"
}
],
"name": {
"givenName": "James",
"familyName": "Bond",
"formatted":"James Bond"
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "007",
"employeeNumber": 007
}
}
Delete an existing entry for a resource type:
DELETE /scim2/v2/[ResourceType Endpoint]/[Entry DN]
Update (Patch allows partial updates) an existing entry for a resource type:
PATCH /scim2/v2/[ResourceType Endpoint]/[Entry DN]
Service Metadata
SCIM Official Specification & Documentation